<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfCommunicationManager</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.0">
<link rel="home" href="index.html" title="libinfinity-0.4 Reference Manual">
<link rel="up" href="ch06.html" title="Network abstraction">
<link rel="prev" href="ch06.html" title="Network abstraction">
<link rel="next" href="InfCommunicationObject.html" title="InfCommunicationObject">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch06.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinfinity-0.4 Reference Manual</th>
<td><a accesskey="n" href="InfCommunicationObject.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfCommunicationManager.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#InfCommunicationManager.description" class="shortcut">Description</a>
                   | 
                  <a href="#InfCommunicationManager.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry" title="InfCommunicationManager">
<a name="InfCommunicationManager"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfCommunicationManager.top_of_page"></a>InfCommunicationManager</span></h2>
<p>InfCommunicationManager — Handling multiple communication sessions</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="InfCommunicationManager.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="InfCommunicationManager.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libinfinity/communication/inf-communication-manager.h&gt;

                    <a class="link" href="InfCommunicationManager.html#InfCommunicationManager-struct" title="InfCommunicationManager">InfCommunicationManager</a>;
                    <a class="link" href="InfCommunicationManager.html#InfCommunicationManagerClass" title="InfCommunicationManagerClass">InfCommunicationManagerClass</a>;
<a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="returnvalue">InfCommunicationManager</span></a> * <a class="link" href="InfCommunicationManager.html#inf-communication-manager-new" title="inf_communication_manager_new ()">inf_communication_manager_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup"><span class="returnvalue">InfCommunicationHostedGroup</span></a> * <a class="link" href="InfCommunicationManager.html#inf-communication-manager-open-group" title="inf_communication_manager_open_group ()">inf_communication_manager_open_group</a>
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *group_name</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> * const*methods</code></em>);
<a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="returnvalue">InfCommunicationJoinedGroup</span></a> * <a class="link" href="InfCommunicationManager.html#inf-communication-manager-join-group" title="inf_communication_manager_join_group ()">inf_communication_manager_join_group</a>
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *group_name</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *publisher_conn</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfCommunicationManager.html#inf-communication-manager-add-factory" title="inf_communication_manager_add_factory ()">inf_communication_manager_add_factory</a>
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationFactory.html" title="InfCommunicationFactory"><span class="type">InfCommunicationFactory</span></a> *factory</code></em>);
<a class="link" href="InfCommunicationFactory.html" title="InfCommunicationFactory"><span class="returnvalue">InfCommunicationFactory</span></a> * <a class="link" href="InfCommunicationManager.html#inf-communication-manager-get-factory-for" title="inf_communication_manager_get_factory_for ()">inf_communication_manager_get_factory_for</a>
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *network</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method_name</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="InfCommunicationManager.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----InfCommunicationManager
</pre>
</div>
<div class="refsect1" title="Description">
<a name="InfCommunicationManager.description"></a><h2>Description</h2>
<p>
<a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> manages multiple communication sessions
represented by <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a>. A <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> provides an
easy way to send messages between group members, possibly sharing
connections with other groups handled by the same <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.
</p>
</div>
<div class="refsect1" title="Details">
<a name="InfCommunicationManager.details"></a><h2>Details</h2>
<div class="refsect2" title="InfCommunicationManager">
<a name="InfCommunicationManager-struct"></a><h3>InfCommunicationManager</h3>
<pre class="programlisting">typedef struct _InfCommunicationManager InfCommunicationManager;</pre>
<p>
<a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> is an opaque data type. You should only access it
via the public API functions.
</p>
</div>
<hr>
<div class="refsect2" title="InfCommunicationManagerClass">
<a name="InfCommunicationManagerClass"></a><h3>InfCommunicationManagerClass</h3>
<pre class="programlisting">typedef struct {
} InfCommunicationManagerClass;
</pre>
<p>
This structure does not contain any public fields.
</p>
</div>
<hr>
<div class="refsect2" title="inf_communication_manager_new ()">
<a name="inf-communication-manager-new"></a><h3>inf_communication_manager_new ()</h3>
<pre class="programlisting"><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="returnvalue">InfCommunicationManager</span></a> * inf_communication_manager_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A new <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_communication_manager_open_group ()">
<a name="inf-communication-manager-open-group"></a><h3>inf_communication_manager_open_group ()</h3>
<pre class="programlisting"><a class="link" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup"><span class="returnvalue">InfCommunicationHostedGroup</span></a> * inf_communication_manager_open_group
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *group_name</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> * const*methods</code></em>);</pre>
<p>
Opens a new communication group published by the local host. <em class="parameter"><code>group_name</code></em>
is an identifier for the group via which other hosts can join the group
using <a class="link" href="InfCommunicationManager.html#inf-communication-manager-join-group" title="inf_communication_manager_join_group ()"><code class="function">inf_communication_manager_join_group()</code></a>. It needs to be unique among
all groups opened by the local host.
</p>
<p>
<em class="parameter"><code>methods</code></em> specifies what communication methods the group should use, in
order of priority. If a method is not supported for a given network, then
the next one in the array is tried. If none is supported, then the
"central" method will be used, which is guaranteed to be supported for
all networks.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>A <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
<td>A name for the new group.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>methods</code></em> :</span></p></td>
<td>Methods to support, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a class="link" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup"><span class="type">InfCommunicationHostedGroup</span></a>. Free with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> to
leave the group.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_communication_manager_join_group ()">
<a name="inf-communication-manager-join-group"></a><h3>inf_communication_manager_join_group ()</h3>
<pre class="programlisting"><a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="returnvalue">InfCommunicationJoinedGroup</span></a> * inf_communication_manager_join_group
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *group_name</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *publisher_conn</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>);</pre>
<p>
Joins a communication group published by a remote host. <em class="parameter"><code>publisher_conn</code></em>
needs to be a to the publishing host with status <code class="literal">INF_XML_CONNECTION_OPEN</code>
or <code class="literal">INF_XML_CONNECTION_OPENING</code>. <em class="parameter"><code>group_name</code></em> specifies the name of the group
to join.
</p>
<p>
<em class="parameter"><code>method</code></em> specifies the communication method to use. It must match the
communication method the publisher has chosen for <em class="parameter"><code>publisher_conn</code></em>'s network
(see <a class="link" href="InfCommunicationGroup.html#inf-communication-group-get-method-for-network" title="inf_communication_group_get_method_for_network ()"><code class="function">inf_communication_group_get_method_for_network()</code></a>). The function
returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>method</code></em> is not supported (which means
<a class="link" href="InfCommunicationManager.html#inf-communication-manager-get-factory-for" title="inf_communication_manager_get_factory_for ()"><code class="function">inf_communication_manager_get_factory_for()</code></a> for <em class="parameter"><code>publisher_conn</code></em>'s network
and <em class="parameter"><code>method</code></em> returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>A <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
<td>The group to join.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>publisher_conn</code></em> :</span></p></td>
<td>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> to the publishing host.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>The communication method to use.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A new <a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Free with
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> to leave the group.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_communication_manager_add_factory ()">
<a name="inf-communication-manager-add-factory"></a><h3>inf_communication_manager_add_factory ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                inf_communication_manager_add_factory
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationFactory.html" title="InfCommunicationFactory"><span class="type">InfCommunicationFactory</span></a> *factory</code></em>);</pre>
<p>
Adds a new <a class="link" href="InfCommunicationFactory.html" title="InfCommunicationFactory"><span class="type">InfCommunicationFactory</span></a> to <em class="parameter"><code>manager</code></em>. This makes <em class="parameter"><code>manager</code></em>
support all method/network combinations that <em class="parameter"><code>factory</code></em> supports. If multiple
added factories support the same combination, the one which was added first
will be used to instantiate the <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>A <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
<td>The <a class="link" href="InfCommunicationFactory.html" title="InfCommunicationFactory"><span class="type">InfCommunicationFactory</span></a> to add.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_communication_manager_get_factory_for ()">
<a name="inf-communication-manager-get-factory-for"></a><h3>inf_communication_manager_get_factory_for ()</h3>
<pre class="programlisting"><a class="link" href="InfCommunicationFactory.html" title="InfCommunicationFactory"><span class="returnvalue">InfCommunicationFactory</span></a> * inf_communication_manager_get_factory_for
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *network</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method_name</code></em>);</pre>
<p>
Returns the <a class="link" href="InfCommunicationFactory.html" title="InfCommunicationFactory"><span class="type">InfCommunicationFactory</span></a> that <em class="parameter"><code>manager</code></em> will use to instantiate
a <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> for <em class="parameter"><code>method_name</code></em> on <em class="parameter"><code>network</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the
network/method combination is not supported.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>A <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>network</code></em> :</span></p></td>
<td>A network identifier.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method_name</code></em> :</span></p></td>
<td>A method name.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a class="link" href="InfCommunicationFactory.html" title="InfCommunicationFactory"><span class="type">InfCommunicationFactory</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>